Fix availability logic refactor #1065
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
d-ronnqvist
reviewed
Oct 28, 2024
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Oct 29, 2024
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Oct 29, 2024
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Oct 29, 2024
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Oct 29, 2024
Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Oct 29, 2024
Contributor
d-ronnqvist
left a comment
d-ronnqvist
left a comment
There was a problem hiding this comment.
I think this is a great step towards making this complex logic both more correct and easier to read.
This refactor was initiated by the need of stop using the module operating system name as an availability item. This change required a big refactoring of the logic, and now the symbol graph availability loading logic is like the following: 1. Every symbol graph is loaded and the symbols get only the availability information that's marked in the SDK. 2. Once all the SGFs are oaded, whe iterate over the symbols and we add the fallbkac and default availability if applies.
sofiaromorales
force-pushed
the
fix-availability-logic-refactor
branch
from
61e6e1e to
ec28dd5
Compare
Instead of making a `[(FallbackPlatform, InheritedPlaform)]. The new struture to hold this information is in the way of `[InheritedPlatfor:[FallbackPlatforms]]`.
sofiaromorales
requested review from
anferbui,
d-ronnqvist and
patshaughnessy
d-ronnqvist
reviewed
Nov 27, 2024
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Nov 27, 2024
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Nov 27, 2024
Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
reviewed
Nov 27, 2024
Comment on lines
+289
to
+291
| guard symbolsByPlatformName[defaultAvailability.platformName.rawValue]?.contains(where: { | ||
| symbolID == $0.precise | ||
| }) != false else { |
Contributor
There was a problem hiding this comment.
minor: AFAICT this is the only place that uses symbolsByPlatformName. If that's correct, maybe it would be worth using a set of symbol IDs so that this can use contains(_:) instead of contains(where:).
In other words, changing symbolsByPlatformName from [String: [SymbolGraph.Symbol.Identifier]] to [String: Set]
d-ronnqvist
reviewed
Nov 27, 2024
Sources/SwiftDocC/Infrastructure/Workspace/DefaultAvailability.swift
Outdated
Show resolved
Hide resolved
d-ronnqvist
approved these changes
Nov 27, 2024
Contributor
d-ronnqvist
left a comment
d-ronnqvist
left a comment
There was a problem hiding this comment.
These look like good improvements to me.
I left a few very minor suggestions but nothing blocking.
Contributor
Author
|
@swift-ci please test |
Contributor
Author
|
@swift-ci please test |
1 similar comment
Contributor
Author
|
@swift-ci please test |
Contributor
Author
|
@swift-ci please test |
sofiaromorales
added a commit
to sofiaromorales/swift-docc
that referenced
this pull request
Jan 31, 2025
This reverts commit 1ad9b6a.
sofiaromorales
added a commit
that referenced
this pull request
Jan 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable: 139722227
Summary
DocC current logic for determining API availability involves adding the symbol graphs operating system platform name to the final symbol availability.
This approach is problematic because the platform name may not always be in a human-readable format. While it's necessary for calculating availability, we don't want it included as an explicit availability item.
This is a major refactor of the availability logic to not include the symbolgraph operating system platform name as an availability item.
Dependencies
Describe any dependencies this PR might have, such as an associated branch in another repository.
Testing
Review unit tests added.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded